/**
 * Copyright (c) 2006-2008 by Carnegie Mellon University and others.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the names of the authors nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * This package contains annotations used by the 
 * <a href="http://code.google.com/p/pluralism/">Plural object protocol checker</a>.
 * 
 * To get started, you can take a look at the annotations for associating a
 * <i>permission</i> with a method receiver or parameter, including 
 * {@link edu.cmu.cs.plural.annot.Unique},
 * {@link edu.cmu.cs.plural.annot.Full}, 
 * {@link edu.cmu.cs.plural.annot.Share}, 
 * {@link edu.cmu.cs.plural.annot.Imm}, and 
 * {@link edu.cmu.cs.plural.annot.Pure}.  
 * {@link edu.cmu.cs.plural.annot.Perm} lets you specify more complicated methods.  
 * 
 * Invariants are defined using {@link edu.cmu.cs.plural.annot.State} on classes.  
 * {@link edu.cmu.cs.plural.annot.States} lets you define states explicitly, 
 * e.g., in an interface.
 * 
 * Finally, a set of annotations for conveying aliasing information is available,
 * e.g. {@link edu.cmu.cs.plural.annot.Capture} and 
 * {@link edu.cmu.cs.plural.annot.IsResult}.  
 */
package edu.cmu.cs.plural.annot;